jest-message-util

What is jest-message-util?

The jest-message-util package provides utilities for formatting and handling error messages in Jest, a popular JavaScript testing framework. It is particularly useful for creating custom error messages and enhancing the readability of test results.

What are jest-message-util's main functionalities?

formatStackTrace

The formatStackTrace function formats a stack trace to make it more readable. This is particularly useful for debugging and understanding where errors occur in your tests.

const { formatStackTrace } = require('jest-message-util');
const stack = new Error().stack;
const formattedStack = formatStackTrace(stack, { rootDir: process.cwd(), testMatch: [] });
console.log(formattedStack);

formatExecError

The formatExecError function formats execution errors to provide more context and readability. This helps in quickly identifying the cause of test failures.

const { formatExecError } = require('jest-message-util');
const error = new Error('Test error');
const formattedError = formatExecError(error, { rootDir: process.cwd(), testMatch: [] });
console.log(formattedError);

getTopFrame

The getTopFrame function extracts the top frame from a stack trace. This is useful for pinpointing the exact location of an error in your code.

const { getTopFrame } = require('jest-message-util');
const stack = new Error().stack;
const topFrame = getTopFrame(stack);
console.log(topFrame);

Other packages similar to jest-message-util

stack-utils

The stack-utils package provides utilities for working with stack traces. It offers similar functionality to jest-message-util, such as formatting and parsing stack traces, but is more general-purpose and not specifically tailored for Jest.

error-stack-parser

The error-stack-parser package is designed to parse and extract information from error stack traces. While it offers similar capabilities to jest-message-util in terms of stack trace manipulation, it does not provide the same level of integration with Jest.

pretty-error

The pretty-error package focuses on making error messages more readable by formatting them in a visually appealing way. It offers similar functionality to jest-message-util's formatting features but is more focused on aesthetics and less on integration with testing frameworks.

README

The README file is missing

Changelog

27.5.1

Features

• [jest-config] Support comments in JSON config file (#12316)
• [pretty-format] Expose ConvertAnsi plugin (#12308)

Fixes

• [expect] Add type definitions for asymmetric closeTo matcher (#12304)
• [jest-cli] Load binary via exported API (#12315)
• [jest-config] Replace jsonlint with parse-json (#12316)
• [jest-repl] Make module importable (#12311 & #12315)

Chore & Maintenance

• [*] Avoid anonymous default exports (#12313)